﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System;
using System.Diagnostics.Contracts;
using Aiemp.ObjectModel;

namespace RaisingForce.Raise.Hardware
{
    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
    sealed public class RobotHardwareAttribute :
        Attribute
    {
        #region Constructors

        public RobotHardwareAttribute(string keyString, string name)
        {
            if (keyString == null)
            {
                throw new ArgumentNullException("keyString");
            }
            if (string.IsNullOrWhiteSpace(name))
            {
                throw new ArgumentException("name");
            }
            Contract.EndContractBlock();
            RegistryKey key = (RegistryKey)keyString;
            key.Validate();
            this.key = key;
            this.info = new RobotHardwareInfo(name);
        }

        #endregion

        #region Private Declarations

        private readonly RegistryKey key;

        private readonly RobotHardwareInfo info;

        #endregion

        #region Properties

        public RegistryKey Key
        {
            get { return this.key; }
        }

        public string Name
        {
            get { return this.info.Name; }
        }

        public string Description
        {
            get
            {
                Contract.Ensures(Contract.Result<string>() != null);
                return this.info.Description;
            }
            set
            {
                if (value == null)
                {
                    throw new ArgumentNullException("Description");
                }
                Contract.EndContractBlock();
                this.info.Description = value;
            }
        }

        #endregion

        #region Internal Methods

        internal RobotHardwareInfo GetInfo()
        {
            Contract.Ensures(Contract.Result<RobotHardwareInfo>() != null);
            return this.info;
        }

        #endregion
    }
}
